From ab2b14c304258694a4e34da1da8c9bda738a65fd Mon Sep 17 00:00:00 2001 From: robertl Date: Tue, 6 Jun 2006 21:36:06 +0000 Subject: [PATCH] Document various Garmin-specific options. --- xmldoc/formats/options/garmin-category.xml | 4 +++- xmldoc/formats/options/garmin-deficon.xml | 16 ++++++++++++++++ xmldoc/formats/options/garmin-get_posn.xml | 6 +++++- xmldoc/formats/options/garmin-power_off.xml | 7 +++++++ xmldoc/formats/options/garmin-snlen.xml | 8 +++++++- xmldoc/formats/options/garmin-snwhite.xml | 3 ++- 6 files changed, 40 insertions(+), 4 deletions(-) diff --git a/xmldoc/formats/options/garmin-category.xml b/xmldoc/formats/options/garmin-category.xml index 8b1378917..83ed08f2c 100644 --- a/xmldoc/formats/options/garmin-category.xml +++ b/xmldoc/formats/options/garmin-category.xml @@ -1 +1,3 @@ - +This numeric option will force waypoints to be written with that +category number when sending to a Garmin receiver that has category +support. It is ignored on receivers without that capability. diff --git a/xmldoc/formats/options/garmin-deficon.xml b/xmldoc/formats/options/garmin-deficon.xml index 8b1378917..26ff03d89 100644 --- a/xmldoc/formats/options/garmin-deficon.xml +++ b/xmldoc/formats/options/garmin-deficon.xml @@ -1 +1,17 @@ + +This option specifies the icon or waypoint type to write for each waypoint on +output. + + +If this option is specified, its value will be used for all waypoints, not +just those that do not already have descriptions. That is, this option +overrides any icon description that might be in the input file. + + +Value specified may be a number from the Garmin Protocol Spec or a name +as described in the . + + +This option has no effect on input. + diff --git a/xmldoc/formats/options/garmin-get_posn.xml b/xmldoc/formats/options/garmin-get_posn.xml index 8b1378917..f4d49e18e 100644 --- a/xmldoc/formats/options/garmin-get_posn.xml +++ b/xmldoc/formats/options/garmin-get_posn.xml @@ -1 +1,5 @@ - +This options gets the current position from the attached GPS device +and returns it as a single waypoint for further processing. For example, +to return the current position from a USB Garmin to a KML file: +gpsbabel -i garmin -f usb: -o kml -F myposition.kml + diff --git a/xmldoc/formats/options/garmin-power_off.xml b/xmldoc/formats/options/garmin-power_off.xml index 8b1378917..63c22850d 100644 --- a/xmldoc/formats/options/garmin-power_off.xml +++ b/xmldoc/formats/options/garmin-power_off.xml @@ -1 +1,8 @@ +This command forces an immediate powerdown of the addressed Garmin +receiver. It is ignored on hardware that does not support this command. +Obviously, further processing once you have sent a "power off" command to +a unit that supports it is rather futile, so place this option carefully +in your command. +gpsbabel -o garmin,power_off -F /dev/ttyS0 + diff --git a/xmldoc/formats/options/garmin-snlen.xml b/xmldoc/formats/options/garmin-snlen.xml index 8b1378917..3aa721c67 100644 --- a/xmldoc/formats/options/garmin-snlen.xml +++ b/xmldoc/formats/options/garmin-snlen.xml @@ -1 +1,7 @@ - +This option overrides the internal logic to figure out how many +characters an addressed Garmin GPS will support when using the '-s' smartname +option. This should be necessary only if you have a receiver type that +GPSBabel doesn't know about or if you want to "dumb down" one unit to match +another, such as wanting waypoint names in a StreetPilot 2720 (which supports +20 character names) to exactly match those in a 60CS (which supports 10). + diff --git a/xmldoc/formats/options/garmin-snwhite.xml b/xmldoc/formats/options/garmin-snwhite.xml index 8b1378917..8a2f1987a 100644 --- a/xmldoc/formats/options/garmin-snwhite.xml +++ b/xmldoc/formats/options/garmin-snwhite.xml @@ -1 +1,2 @@ - +This options controls whether spaces are allowed in generated +smart names when using the '-s' option. -- 2.30.2